Steinberg Namespace Reference

Data Structures

class  ConstStringTable
 Constant unicode string table. More...
class  FUID
 Handling 16 Byte Globaly Unique Identifiers. More...
class  FUnknown
 The basic interface of all interfaces. More...
class  IPtr
 IPtr - Smart pointer template class. More...
class  OPtr
 OPtr - "owning" smart pointer used for newly created FObjects. More...
class  FUnknownPtr
 FUnknownPtr - automatic interface conversion and smart pointer in one. More...
class  FVariant
 A Value of variable type. More...
struct  FReleaser
 Release an interface using automatic object (obsolete). More...
class  IBStream
 Base class for streams. More...
class  ISizeableStream
 Stream with a size. More...
class  ICloneable
 Interface allowing an object to be copied. More...
class  IErrorContext
 Interface for error handling. More...
class  IPersistent
 Persistent Object Interface. More...
class  IAttributes
 Object Data Archive Interface. More...
class  IAttributes2
 Extended access to Attributes; supports Attribute retrieval via iteration. More...
class  IPluginBase
 Basic interface to a Plug-in component. More...
struct  PFactoryInfo
 Basic Information about the class factory of the Plug-in. More...
struct  PClassInfo
 Basic Information about a class provided by the Plug-in. More...
class  IPluginFactory
 Class factory that any Plug-in defines for creating class instances. More...
struct  PClassInfo2
 Version 2 of Basic Information about a class provided by the Plug-in. More...
class  IPluginFactory2
 Version 2 of class factory supporting PClassInfo2. More...
struct  PClassInfoW
 Unicode Version of Basic Information about a class provided by the Plug-in. More...
class  IPluginFactory3
 Version 3 of class factory supporting PClassInfoW. More...
class  IStringResult
 Interface to return an ascii string of variable size. More...
class  IString
 Interface to a string of variable size and encoding. More...
class  IUpdateHandler
 Host implements dependency handling for plugins. More...
class  IDependent
 A dependent will get notified about changes of a model. More...
class  UString
 UTF-16 string class without buffer management. More...
class  UStringBuffer
 UTF-16 string with fixed buffer size. More...
struct  ViewRect
 Graphical rectangle structure. More...
class  IPlugView
 Plug-in definition of a view. More...
class  IPlugFrame
 Callback interface passed to IPlugView. More...

Typedefs

typedef char int8
typedef unsigned char uint8
typedef unsigned char uchar
typedef short int16
typedef unsigned short uint16
typedef long int32
typedef unsigned long uint32
typedef long long int64
typedef unsigned long long uint64
typedef int64 TSize
typedef int32 tresult
typedef uint32 TPtrInt
typedef uint8 TBool
typedef char char8
typedef uint16 char16
typedef char16 char
typedef const char8CStringA
typedef const char16CStringW
typedef const charCString
typedef const char8FIDString
typedef int32 UCoord
 Coordinates.
typedef int64 LARGE_INT
typedef int8 TUID [16]
 plain UID type
typedef FIDString IAttrID
typedef UStringBuffer< 128 > UString128
 128 character UTF-16 string
typedef UStringBuffer< 256 > UString256
 256 character UTF-16 string

Enumerations

enum  {
  kNoInterface = -1, kResultOk, kResultTrue = kResultOk, kResultFalse,
  kInvalidArgument, kNotImplemented, kInternalError, kNotInitialized,
  kOutOfMemory
}
enum  VirtualKeyCodes {
  KEY_BACK = 1, KEY_TAB, KEY_CLEAR, KEY_RETURN,
  KEY_PAUSE, KEY_ESCAPE, KEY_SPACE, KEY_NEXT,
  KEY_END, KEY_HOME, KEY_LEFT, KEY_UP,
  KEY_RIGHT, KEY_DOWN, KEY_PAGEUP, KEY_PAGEDOWN,
  KEY_SELECT, KEY_PRINT, KEY_ENTER, KEY_SNAPSHOT,
  KEY_INSERT, KEY_DELETE, KEY_HELP, KEY_NUMPAD0,
  KEY_NUMPAD1, KEY_NUMPAD2, KEY_NUMPAD3, KEY_NUMPAD4,
  KEY_NUMPAD5, KEY_NUMPAD6, KEY_NUMPAD7, KEY_NUMPAD8,
  KEY_NUMPAD9, KEY_MULTIPLY, KEY_ADD, KEY_SEPARATOR,
  KEY_SUBTRACT, KEY_DECIMAL, KEY_DIVIDE, KEY_F1,
  KEY_F2, KEY_F3, KEY_F4, KEY_F5,
  KEY_F6, KEY_F7, KEY_F8, KEY_F9,
  KEY_F10, KEY_F11, KEY_F12, KEY_NUMLOCK,
  KEY_SCROLL, KEY_SHIFT, KEY_CONTROL, KEY_ALT,
  KEY_EQUALS, KEY_CONTEXTMENU, KEY_MEDIA_PLAY, KEY_MEDIA_STOP,
  KEY_MEDIA_PREV, KEY_MEDIA_NEXT, KEY_VOLUME_UP, KEY_VOLUME_DOWN,
  KEY_F13, KEY_F14, KEY_F15, KEY_F16,
  KEY_F17, KEY_F18, KEY_F19, VKEY_FIRST_CODE = KEY_BACK,
  VKEY_LAST_CODE = KEY_F19, VKEY_FIRST_ASCII = 128
}
 

Virtual Key Codes.

More...
enum  KeyModifier { kShiftKey = 1 << 0, kAlternateKey = 1 << 1, kCommandKey = 1 << 2, kControlKey = 1 << 3 }

Functions

template<class T >
int32 _tstrlen (const T *wcs)
int32 tstrlen (const char *str)
int32 strlen8 (const char8 *str)
int32 strlen16 (const char16 *str)
template<class T >
int32 _tstrcmp (const T *src, const T *dst)
int32 tstrcmp (const char *src, const char *dst)
int32 strcmp8 (const char8 *src, const char8 *dst)
int32 strcmp16 (const char16 *src, const char16 *dst)
template<class T >
int32 _tstrncmp (const T *first, const T *last, uint32 count)
int32 tstrncmp (const char *first, const char *last, uint32 count)
int32 strncmp8 (const char8 *first, const char8 *last, uint32 count)
int32 strncmp16 (const char16 *first, const char16 *last, uint32 count)
template<class T >
T * _tstrcpy (T *dst, const T *src)
chartstrcpy (char *dst, const char *src)
char8strcpy8 (char8 *dst, const char8 *src)
char16strcpy16 (char16 *dst, const char16 *src)
template<class T >
T * _tstrncpy (T *dest, const T *source, uint32 count)
chartstrncpy (char *dest, const char *source, uint32 count)
char8strncpy8 (char8 *dest, const char8 *source, uint32 count)
char16strncpy16 (char16 *dest, const char16 *source, uint32 count)
template<class T >
T * _tstrcat (T *dst, const T *src)
chartstrcat (char *dst, const char *src)
char8strcat8 (char8 *dst, const char8 *src)
char16strcat16 (char16 *dst, const char16 *src)
void str8ToStr16 (char16 *dst, const char8 *src, int32 n=-1)
bool FIDStringsEqual (FIDString id1, FIDString id2)
bool strEmpty (const char *str)
bool str8Empty (const char8 *str)
bool str16Empty (const char16 *str)
template<class I >
IPtr< I > owned (I *p)
 Assigning newly created object to an IPtr.
template<class T >
const T & Min (const T &a, const T &b)
template<class T >
const T & Max (const T &a, const T &b)
template<class T >
Abs (const T &value)
template<class T >
Sign (const T &value)
template<class T >
Bound (T minval, T maxval, T x)
template<class T >
void Swap (T &t1, T &t2)
template<class T >
bool IsApproximateEqual (T t1, T t2, T epsilon)
char VirtualKeyCodeToChar (uint8 vKey)
uint8 CharToVirtualKeyCode (char character)
template<class TDstChar , class TSrcChar >
void StringCopy (TDstChar *dst, int32 dstSize, const TSrcChar *src, int32 srcSize=-1)
 Copy strings of different character width.
template<class TSrcChar >
int32 StringLength (const TSrcChar *src, int32 srcSize=-1)
 Find length of null-terminated string.

Variables

const FIDString kPlatformStringWin = "WIN"
const FIDString kPlatformStringMac = "MAC"
const FIDString kPlatformStringIOS = "IOS"
const FIDString kPlatformTypeHWND = "HWND"
 The parent parameter in IPlugView::attached() is a HWND handle.
const FIDString kPlatformTypeHIView = "HIView"
 The parent parameter in IPlugView::attached() is a WindowRef.
const FIDString kPlatformTypeNSView = "NSView"
 The parent parameter in IPlugView::attached() is a NSView pointer.
const FIDString kPlatformTypeUIView = "UIView"
 The parent parameter in IPlugView::attached() is a UIView pointer.

Typedef Documentation

typedef char int8
typedef unsigned char uint8
typedef unsigned char uchar
typedef short int16
typedef unsigned short uint16
typedef long int32
typedef unsigned long uint32
typedef long long int64
typedef unsigned long long uint64
typedef int64 TSize
typedef int32 tresult
typedef uint32 TPtrInt
typedef uint8 TBool
typedef char char8
typedef uint16 char16
typedef char16 char
typedef const char8* CStringA
typedef const char16* CStringW
typedef const char* CString
typedef const char8* FIDString
typedef int32 UCoord

Coordinates.

typedef int64 LARGE_INT
typedef int8 TUID[16]

plain UID type

typedef FIDString IAttrID
typedef UStringBuffer<128> UString128

128 character UTF-16 string

typedef UStringBuffer<256> UString256

256 character UTF-16 string


Enumeration Type Documentation

anonymous enum
Enumerator:
kNoInterface 
kResultOk 
kResultTrue 
kResultFalse 
kInvalidArgument 
kNotImplemented 
kInternalError 
kNotInitialized 
kOutOfMemory 

Virtual Key Codes.

OS-independent enumeration of virtual keycodes.

Enumerator:
KEY_BACK 
KEY_TAB 
KEY_CLEAR 
KEY_RETURN 
KEY_PAUSE 
KEY_ESCAPE 
KEY_SPACE 
KEY_NEXT 
KEY_END 
KEY_HOME 
KEY_LEFT 
KEY_UP 
KEY_RIGHT 
KEY_DOWN 
KEY_PAGEUP 
KEY_PAGEDOWN 
KEY_SELECT 
KEY_PRINT 
KEY_ENTER 
KEY_SNAPSHOT 
KEY_INSERT 
KEY_DELETE 
KEY_HELP 
KEY_NUMPAD0 
KEY_NUMPAD1 
KEY_NUMPAD2 
KEY_NUMPAD3 
KEY_NUMPAD4 
KEY_NUMPAD5 
KEY_NUMPAD6 
KEY_NUMPAD7 
KEY_NUMPAD8 
KEY_NUMPAD9 
KEY_MULTIPLY 
KEY_ADD 
KEY_SEPARATOR 
KEY_SUBTRACT 
KEY_DECIMAL 
KEY_DIVIDE 
KEY_F1 
KEY_F2 
KEY_F3 
KEY_F4 
KEY_F5 
KEY_F6 
KEY_F7 
KEY_F8 
KEY_F9 
KEY_F10 
KEY_F11 
KEY_F12 
KEY_NUMLOCK 
KEY_SCROLL 
KEY_SHIFT 
KEY_CONTROL 
KEY_ALT 
KEY_EQUALS 
KEY_CONTEXTMENU 
KEY_MEDIA_PLAY 
KEY_MEDIA_STOP 
KEY_MEDIA_PREV 
KEY_MEDIA_NEXT 
KEY_VOLUME_UP 
KEY_VOLUME_DOWN 
KEY_F13 
KEY_F14 
KEY_F15 
KEY_F16 
KEY_F17 
KEY_F18 
KEY_F19 
VKEY_FIRST_CODE 
VKEY_LAST_CODE 
VKEY_FIRST_ASCII 
Enumerator:
kShiftKey 

same on both PC and Mac

kAlternateKey 

same on both PC and Mac

kCommandKey 

windows ctrl key; mac cmd key (apple button)

kControlKey 

windows: not assigned, mac: ctrl key


Function Documentation

int32 Steinberg::_tstrlen ( const T *  wcs  )  [inline]
int32 Steinberg::tstrlen ( const char *  str  )  [inline]
int32 Steinberg::strlen8 ( const char8 *  str  )  [inline]
int32 Steinberg::strlen16 ( const char16 *  str  )  [inline]
int32 Steinberg::_tstrcmp ( const T *  src,
const T *  dst 
) [inline]
int32 Steinberg::tstrcmp ( const char *  src,
const char *  dst 
) [inline]
int32 Steinberg::strcmp8 ( const char8 *  src,
const char8 *  dst 
) [inline]
int32 Steinberg::strcmp16 ( const char16 *  src,
const char16 *  dst 
) [inline]
int32 Steinberg::_tstrncmp ( const T *  first,
const T *  last,
uint32  count 
) [inline]
int32 Steinberg::tstrncmp ( const char *  first,
const char *  last,
uint32  count 
) [inline]
int32 Steinberg::strncmp8 ( const char8 *  first,
const char8 *  last,
uint32  count 
) [inline]
int32 Steinberg::strncmp16 ( const char16 *  first,
const char16 *  last,
uint32  count 
) [inline]
T* Steinberg::_tstrcpy ( T *  dst,
const T *  src 
) [inline]
char* Steinberg::tstrcpy ( char *  dst,
const char *  src 
) [inline]
char8* Steinberg::strcpy8 ( char8 *  dst,
const char8 *  src 
) [inline]
char16* Steinberg::strcpy16 ( char16 *  dst,
const char16 *  src 
) [inline]
T* Steinberg::_tstrncpy ( T *  dest,
const T *  source,
uint32  count 
) [inline]
char* Steinberg::tstrncpy ( char *  dest,
const char *  source,
uint32  count 
) [inline]
char8* Steinberg::strncpy8 ( char8 *  dest,
const char8 *  source,
uint32  count 
) [inline]
char16* Steinberg::strncpy16 ( char16 *  dest,
const char16 *  source,
uint32  count 
) [inline]
T* Steinberg::_tstrcat ( T *  dst,
const T *  src 
) [inline]
char* Steinberg::tstrcat ( char *  dst,
const char *  src 
) [inline]
char8* Steinberg::strcat8 ( char8 *  dst,
const char8 *  src 
) [inline]
char16* Steinberg::strcat16 ( char16 *  dst,
const char16 *  src 
) [inline]
void Steinberg::str8ToStr16 ( char16 *  dst,
const char8 *  src,
int32  n = -1 
) [inline]
bool Steinberg::FIDStringsEqual ( FIDString  id1,
FIDString  id2 
) [inline]
bool Steinberg::strEmpty ( const char *  str  )  [inline]
bool Steinberg::str8Empty ( const char8 *  str  )  [inline]
bool Steinberg::str16Empty ( const char16 *  str  )  [inline]
IPtr<I> Steinberg::owned ( I *  p  )  [inline]

Assigning newly created object to an IPtr.

Example:

   IPtr<IPath> path = owned (FHostCreate (IPath, hostClasses));

which is a slightly shorter form of writing:

   IPtr<IPath> path = OPtr<IPath> (FHostCreate (IPath, hostClasses));
const T& Steinberg::Min ( const T &  a,
const T &  b 
) [inline]
const T& Steinberg::Max ( const T &  a,
const T &  b 
) [inline]
T Steinberg::Abs ( const T &  value  )  [inline]
T Steinberg::Sign ( const T &  value  )  [inline]
T Steinberg::Bound ( minval,
maxval,
x 
) [inline]
void Steinberg::Swap ( T &  t1,
T &  t2 
) [inline]
bool Steinberg::IsApproximateEqual ( t1,
t2,
epsilon 
) [inline]
char Steinberg::VirtualKeyCodeToChar ( uint8  vKey  )  [inline]
uint8 Steinberg::CharToVirtualKeyCode ( char  character  )  [inline]
void Steinberg::StringCopy ( TDstChar *  dst,
int32  dstSize,
const TSrcChar *  src,
int32  srcSize = -1 
) [inline]

Copy strings of different character width.

int32 Steinberg::StringLength ( const TSrcChar *  src,
int32  srcSize = -1 
) [inline]

Find length of null-terminated string.


Variable Documentation

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.